Added support for lifecycle.started option by andrewnester · Pull Request #4672 · databricks/cli

andrewnester · 2026-03-06T10:05:07Z

Changes

Added support for lifecycle.started option

Why

This new option allows to start resources such as apps, clusters and sql warehouses in started/active state.
For apps: when this option enabled, on each bundle deploy we automatically will trigger a new app deploy

Tests

Added an acceptance test

eng-dev-ecosystem-bot · 2026-03-06T10:21:34Z

Commit: a79625c

Run: 22765516146

	Env	🪲BUG	❌FAIL	🟨KNOWN	🔄flaky	💚RECOVERED	🙈SKIP	✅pass	🙈skip	Time
🟨	aws linux			7		1	7	268	781	7:49
🟨	aws windows			7		1	7	270	779	7:41
🔄	aws-ucws linux				2	7	7	364	696	7:46
🔄	aws-ucws windows				2	7	7	366	694	7:05
🪲	azure linux	1	8	1		1	9	262	779	142:44
🪲	azure windows	1	8	1		1	9	264	777	144:49
🪲	azure-ucws linux	1	8	1	1	1	9	360	692	147:56
🪲	azure-ucws windows	1	8	1	1	1	9	362	690	138:16
🪲	gcp linux	1	8	1		1	9	258	782	142:23
🪲	gcp windows	1	8	1		1	9	260	780	143:55

25 interesting tests: 8 FAIL, 7 KNOWN, 7 SKIP, 1 BUG, 1 flaky, 1 RECOVERED

	Test Name	aws linux	aws windows	aws-ucws linux	aws-ucws windows	azure linux	azure windows	azure-ucws linux	azure-ucws windows	gcp linux	gcp windows
🟨	TestAccept	🟨K	🟨K	🔄f	🔄f	🟨K	🟨K	🟨K	🟨K	🟨K	🟨K
🪲	TestAccept/bundle/deployment/bind/alert	🙈s	🙈s	🙈s	🙈s	🪲B	🪲B	🪲B	🪲B	🪲B	🪲B
❌	TestAccept/bundle/deployment/bind/alert/DATABRICKS_BUNDLE_ENGINE=direct					❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/deployment/bind/alert/DATABRICKS_BUNDLE_ENGINE=terraform					❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/generate/alert	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/generate/alert/DATABRICKS_BUNDLE_ENGINE=direct	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/generate/alert/DATABRICKS_BUNDLE_ENGINE=terraform	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/resources/alerts/with_file	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/resources/alerts/with_file/DATABRICKS_BUNDLE_ENGINE=direct	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
❌	TestAccept/bundle/resources/alerts/with_file/DATABRICKS_BUNDLE_ENGINE=terraform	✅p	✅p	✅p	✅p	❌F	❌F	❌F	❌F	❌F	❌F
🙈	TestAccept/bundle/resources/permissions	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions	🟨K	🟨K	💚R	💚R	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions/DATABRICKS_BUNDLE_ENGINE=direct	🟨K	🟨K	💚R	💚R
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions/DATABRICKS_BUNDLE_ENGINE=terraform	🟨K	🟨K	💚R	💚R
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions	🟨K	🟨K	💚R	💚R	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions/DATABRICKS_BUNDLE_ENGINE=direct	🟨K	🟨K	💚R	💚R
🟨	TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions/DATABRICKS_BUNDLE_ENGINE=terraform	🟨K	🟨K	💚R	💚R
🙈	TestAccept/bundle/resources/postgres_branches/basic	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/postgres_branches/recreate	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/postgres_branches/update_protected	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/postgres_branches/without_branch_id	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/postgres_endpoints/recreate	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🙈	TestAccept/bundle/resources/synced_database_tables/basic	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S	🙈S
🔄	TestAccept/ssh/connect-serverless-gpu	🙈s	🙈s	🔄f	🔄f	🙈s	🙈s	🔄f	🔄f	🙈s	🙈s
💚	TestAccept/ssh/connection	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R	💚R

Top 20 slowest tests (at least 2 minutes):

duration	env	testname
4:18	azure linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
4:17	azure windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
4:09	gcp linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:50	aws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:40	gcp windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:34	aws-ucws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:31	aws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:24	aws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:18	aws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:13	gcp windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:10	gcp linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:06	aws-ucws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:02	aws-ucws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:58	aws-ucws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:18	azure-ucws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:15	azure-ucws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:11	azure linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:08	azure-ucws windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:07	azure-ucws linux	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:06	azure windows	TestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct

bundle/direct/dresources/app.go

denik · 2026-03-06T10:25:49Z

bundle/direct/dresources/app.go

+		App:            input.App,
+		SourceCodePath: input.SourceCodePath,
+		Config:         input.Config,
+		GitSource:      input.GitSource,


Why do we need all these new fields to support 'started' state?

Also, why don't we track 'bool started' here?

Why do we need all these new fields to support 'started' state?

While working on the feature I realised we don;t track these field in the state correctly, so fixed it. Started should be here as well indeed, will add it

Fixed here da107eb

While working on the feature I realised we don;t track these field in the state correctly, so fixed it.

Interesting, is that possible to have a regression test for this + fix in a separate PR? I wonder how our test suite missed this omission, is that because none of our configs use that fields?

Can we add a new invariant test config or extend existing one with these fields? That should take care of the rest.

I need to keep these fields here because I introduce AppState and Started field, so I would prefer not to make multiple PRs out of it.

But I will add a regression test and investigate why we missed it in a separate PR, we have tests that included all of these fields including invariant test with SourceCodePath field in

But I will add a regression test and investigate why we missed it in a separate PR, we have tests that included all of these fields including invariant test with SourceCodePath field in

okay, let's review this first. It still seems that AppState/SourceCodePath/Config/GitSource change is big enough to deserve its own PR / changelog entry but let's see the root cause first.

bundle/direct/bundle_apply.go

denik · 2026-03-09T08:50:51Z

acceptance/bundle/lifecycle/started/test.toml

+Ignore = [".databricks"]
+
+[EnvMatrix]
+  DATABRICKS_BUNDLE_ENGINE = ["direct"]


Why not run this test on terraform as well, to assert the error?

denik · 2026-03-09T08:52:59Z

acceptance/bundle/resources/apps/lifecycle-started/test.toml

+Ignore = [".databricks", "databricks.yml"]
+
+[EnvMatrix]
+  DATABRICKS_BUNDLE_ENGINE = ["direct"]


Same q - why not run this on terraform to see what kind of error we get?

denik · 2026-03-09T08:55:01Z

bundle/config/mutator/validate_lifecycle_started.go

+}
+
+func (m *validateLifecycleStarted) Apply(_ context.Context, b *bundle.Bundle) diag.Diagnostics {
+	// lifecycle.started is a direct-mode-only feature; ignore it in other modes.


Why not reject it with error? Otherwise people might add / copy-paste config thinking it'll do something but it'll be quietly ignored.

denik · 2026-03-09T08:57:38Z

bundle/config/mutator/validate_lifecycle_started_test.go

+
+func boolPtr(b bool) *bool { return &b }
+
+func TestValidateLifecycleStarted_UnsupportedResource(t *testing.T) {


Do these tests add any coverage on top of acceptance tests?

We've discussed some time that it's good not to add any new mutator unit tests because that complicates mutator refactoring and is often misleading due to not taking into account previous and subsequent mutators.

(We can/should add unit tests for local functions that don't work on the whole bundle).

denik · 2026-03-09T08:59:40Z

bundle/direct/dresources/app.go

+		App:            input.App,
+		SourceCodePath: input.SourceCodePath,
+		Config:         input.Config,
+		GitSource:      input.GitSource,


But I will add a regression test and investigate why we missed it in a separate PR, we have tests that included all of these fields including invariant test with SourceCodePath field in

okay, let's review this first. It still seems that AppState/SourceCodePath/Config/GitSource change is big enough to deserve its own PR / changelog entry but let's see the root cause first.

denik · 2026-03-09T09:00:40Z

bundle/direct/dresources/app.go

+	// With lifecycle.started=true, ensure the app compute is running and deploy the latest code.
+	if config.Started {
+		// Start compute if it is stopped (mirrors bundle run behavior).
+		app, err := r.client.Apps.GetByName(ctx, id)


why do we need separate GetByName call here? does not response already have the same type?

denik · 2026-03-09T09:01:43Z

bundle/direct/dresources/app.go

 		AppName:    id,
 		UpdateMask: updateMask,
 	}
 	updateWaiter, err := r.client.Apps.CreateUpdate(ctx, request)


Could it be possible that the only thing that changed is 'started' field, making this API call unnecessary?

denik · 2026-03-09T09:03:56Z

bundle/direct/dresources/app.go

+// localOnlyFields are AppState fields that have no counterpart in the remote state.
+// They must not appear in the App update_mask.
+var localOnlyFields = map[string]bool{
+	"source_code_path": true,


Is it not available? I see source_code_path in https://docs.databricks.com/api/workspace/apps/get response under active_deployment.

denik · 2026-03-09T09:08:30Z

acceptance/bundle/refschema/out.fields.txt

 resources.alerts.*.id	string	ALL
 resources.alerts.*.lifecycle	resources.Lifecycle	INPUT
 resources.alerts.*.lifecycle.prevent_destroy	bool	INPUT
+resources.alerts.*.lifecycle.started	*bool	INPUT


Question, should we have separate Lifecycle struct (LifecycleWithStarted) that has 'started' field so that the schema reflects which types support it?

There is a risk down the road of combinatorial explosion - we can revisit later if we end up there. From users' perspective (this schema, json schema, Python schema) I think it's best to have this type definition tight.

cc @pietern

Added support for lifecycle.started option

4131876

andrewnester requested review from anton-107, denik, pietern, shreyas-goenka and simonfaltum as code owners March 6, 2026 10:05

Merge branch 'main' into feat/lifecycle-started

dec451b

andrewnester temporarily deployed to test-trigger-is March 6, 2026 10:07 — with GitHub Actions Inactive

fixed sche,a

006910a

andrewnester temporarily deployed to test-trigger-is March 6, 2026 10:09 — with GitHub Actions Inactive

denik reviewed Mar 6, 2026

View reviewed changes

andrewnester and others added 2 commits March 6, 2026 14:11

some refactoring and fixed test output

da107eb

Merge branch 'main' into feat/lifecycle-started

0fa3370

andrewnester temporarily deployed to test-trigger-is March 6, 2026 13:12 — with GitHub Actions Inactive

andrewnester requested a review from denik March 6, 2026 13:12

fixed python codegene

a79625c

andrewnester temporarily deployed to test-trigger-is March 6, 2026 13:28 — with GitHub Actions Inactive

denik reviewed Mar 9, 2026

View reviewed changes


		func boolPtr(b bool) *bool { return &b }

		func TestValidateLifecycleStarted_UnsupportedResource(t *testing.T) {

Conversation

andrewnester commented Mar 6, 2026

Changes

Why

Tests

Uh oh!

eng-dev-ecosystem-bot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

eng-dev-ecosystem-bot commented Mar 6, 2026 •

edited

Loading